IRIX Base Documentation 2002 November

home *** CD-ROM | disk | FTP | other *** search

/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / Xm / SgThumbWheel.z / SgThumbWheel

Wrap

Text File | 2002-10-03 | 19.5 KB | 331 lines

TTTThhhhuuuummmmbbbbWWWWhhhheeeeeeeellll((((3333XXXX)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV TTTThhhhuuuummmmbbbbWWWWhhhheeeeeeeellll((((3333XXXX)))) NNNNAAAAMMMMEEEE SSSSggggTTTThhhhuuuummmmbbbbWWWWhhhheeeeeeeellll - The ThumbWheel widget class SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS ####iiiinnnncccclllluuuuddddeeee <<<<SSSSggggmmmm////TTTThhhhuuuummmmbbbbWWWWhhhheeeeeeeellll....hhhh>>>> VVVVEEEERRRRSSSSIIIIOOOONNNN This page documents the version of Sgm that accompanies Motif 2.1. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN ThumbWheel is used by an application to allow the user to input or modify a value either from within a range of values or from an unbounded (infinite) range. A ThumbWheel has an elongated rectangular region within which a wheel graphic is displayed. The user can modify the ThumbWheel's value by spinning the wheel. A ThumbWheel can also include a Home Button located outside the wheel region. This button allows the user to set the ThumbWheel's value to a known position. CCCCllllaaaasssssssseeeessss ThumbWheel inherits behavior and resources from CCCCoooorrrreeee and PPPPrrrriiiimmmmiiiittttiiiivvvveeee classes. The class pointer is ssssggggTTTThhhhuuuummmmbbbbWWWWhhhheeeeeeeellllWWWWiiiiddddggggeeeettttCCCCllllaaaassssssss. The class name is SSSSggggTTTThhhhuuuummmmbbbbWWWWhhhheeeeeeeellll. NNNNeeeewwww RRRReeeessssoooouuuurrrrcccceeeessss The following table defines a set of widget resources used by the programmer to specify data. The programmer can also set the resource values for the inherited classes to set attributes for this widget. To reference a resource by name or by class in a .Xdefaults file, remove the XXXXmmmmNNNN, SSSSggggNNNN, XXXXmmmmCCCC, or SSSSggggCCCC prefix and use the remaining letters. To specify one of the defined values for a resource in a .Xdefaults file, remove the XXXXmmmm prefix and use the remaining letters (in either lowercase or uppercase, but include any underscores between words). The codes in the access column indicate if the given resource can be set at creation time (C), set by using XXXXttttSSSSeeeettttVVVVaaaalllluuuueeeessss (S), retrieved by using XXXXttttGGGGeeeettttVVVVaaaalllluuuueeeessss (G), or is not applicable (N/A). SSSSggggTTTThhhhuuuummmmbbbbWWWWhhhheeeeeeeellll RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt NNNNaaaammmmeeee CCCCllllaaaassssssss TTTTyyyyppppeeee DDDDeeeeffffaaaauuuulllltttt AAAAcccccccceeeessssssss ____________________________________________________________________________________ SgNhomePosition SgCHomePosition int 50 CSG Page 1 (printed 10/3/02) TTTThhhhuuuummmmbbbbWWWWhhhheeeeeeeellll((((3333XXXX)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV TTTThhhhuuuummmmbbbbWWWWhhhheeeeeeeellll((((3333XXXX)))) XmNmaximum XmCMaximum int 100 CSG XmNminimum XmCMinimum int 0 CSG SgNangleRange SgCAngleRange int 150 CSG SgNunitsPerRotation SgCUnitsPerRotation int 240 CSG XmNorientation XmCOrientation unsigned char XmVERTICAL CSG SgNshowHomeButton XmCShowHomeButton Boolean True CSG XmNvalue XmCValue int dynamic CSG XmNvalueChangedCallback XmCCallback XtCallbackList NULL C XmNdragCallback XmCCallback XtCallbackList NULL C SSSSggggNNNNhhhhoooommmmeeeePPPPoooossssiiiittttiiiioooonnnn Specifies the "known value" to which the thumb wheel's value is set when the home button is clicked. XXXXmmmmNNNNmmmmaaaaxxxxiiiimmmmuuuummmm Specifies the thumb wheel's maximum value. XXXXmmmmNNNNmmmmaaaaxxxxiiiimmmmuuuummmm must be greater than or equal to XXXXmmmmNNNNmmmmiiiinnnniiiimmmmuuuummmm. Setting XXXXmmmmNNNNmmmmaaaaxxxxiiiimmmmuuuummmm equal to XXXXmmmmNNNNmmmmiiiinnnniiiimmmmuuuummmm indicates an infinite range. XXXXmmmmNNNNmmmmiiiinnnniiiimmmmuuuummmm Specifies the thumb wheel's minimum value. XXXXmmmmNNNNmmmmaaaaxxxxiiiimmmmuuuummmm must be greater than or equal to XXXXmmmmNNNNmmmmiiiinnnniiiimmmmuuuummmm. Setting XXXXmmmmNNNNmmmmaaaaxxxxiiiimmmmuuuummmm equal to XXXXmmmmNNNNmmmmiiiinnnniiiimmmmuuuummmm indicates an infinite range. SSSSggggNNNNaaaannnngggglllleeeeRRRRaaaannnnggggeeee Specifies the angular range, in degrees, through which the thumb wheel is allowed to rotate. This, in conjunction with XXXXmmmmNNNNmmmmaaaaxxxxiiiimmmmuuuummmm and XXXXmmmmNNNNmmmmiiiinnnniiiimmmmuuuummmm, controls the fineness or coarseness of the wheel control when it is not infinite. If set to zero, the thumb wheel has an infinite range. The default of 150 represents roughly the visible amount of the wheel. Thus clicking at one end of the wheel and dragging the mouse to the other end would give roughly the entire range from XXXXmmmmNNNNmmmmiiiinnnniiiimmmmuuuummmm to XXXXmmmmNNNNmmmmaaaaxxxxiiiimmmmuuuummmm. SSSSggggNNNNuuuunnnniiiittttssssPPPPeeeerrrrRRRRoooottttaaaattttiiiioooonnnn Specifies the change in XXXXmmmmNNNNvvvvaaaalllluuuueeee when the wheel is rotated one full turn around. This controls the fineness or coarseness of the wheel control when the range is infinite. XXXXmmmmNNNNoooorrrriiiieeeennnnttttaaaattttiiiioooonnnn Displays ThumbWheel vertically or horizontally. This resource can have values of XXXXmmmmVVVVEEEERRRRTTTTIIIICCCCAAAALLLL and XXXXmmmmHHHHOOOORRRRIIIIZZZZOOOONNNNTTTTAAAALLLL. Page 2 (printed 10/3/02) TTTThhhhuuuummmmbbbbWWWWhhhheeeeeeeellll((((3333XXXX)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV TTTThhhhuuuummmmbbbbWWWWhhhheeeeeeeellll((((3333XXXX)))) SSSSggggNNNNsssshhhhoooowwwwHHHHoooommmmeeeeBBBBuuuuttttttttoooonnnn Specifies whether a home button should be displayed next to the slider. If the value is True, the home button is displayed. XXXXmmmmNNNNvvvvaaaalllluuuueeee Specifies the current position of the thumb wheel, between XXXXmmmmNNNNmmmmiiiinnnniiiimmmmuuuummmm and XXXXmmmmNNNNmmmmaaaaxxxxiiiimmmmuuuummmm if the thumb wheel is not infinite. XXXXmmmmNNNNvvvvaaaalllluuuueeeeCCCChhhhaaaannnnggggeeeeddddCCCCaaaallllllllbbbbaaaacccckkkk Specifies the list of callbacks that is called when the value of the thumb wheel has changed. The reason sent by the callback is XXXXmmmmCCCCRRRR____VVVVAAAALLLLUUUUEEEE____CCCCHHHHAAAANNNNGGGGEEEEDDDD. XXXXmmmmNNNNddddrrrraaaaggggCCCCaaaallllllllbbbbaaaacccckkkk Specifies the list of callbacks that is called when the wheel position changes as the wheel is being spun. The reason sent by the callback is XXXXmmmmCCCCRRRR____DDDDRRRRAAAAGGGG. IIIInnnnhhhheeeerrrriiiitttteeeedddd RRRReeeessssoooouuuurrrrcccceeeessss ThumbWheel inherits behavior and resources from the following superclasses. For a complete description of each resource, refer to the man page for that superclass. XXXXmmmmPPPPrrrriiiimmmmiiiittttiiiivvvveeee RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt NNNNaaaammmmeeee CCCCllllaaaassssssss TTTTyyyyppppeeee DDDDeeeeffffaaaauuuulllltttt AAAAcccccccceeeessssssss ________________________________________________________________________________________________ XmNbottomShadowColor XmCBottomShadowColor Pixel dynamic CSG XmNbottomShadowPixmap XmCBottomShadowPixmap Pixmap XmUNSPECIFIED_PIXMAP CSG XmNforeground XmCForeground Pixel dynamic CSG XmNhelpCallback XmCCallback XtCallbackList NULL C XmNhighlightColor XmCHighlightColor Pixel dynamic CSG XmNhighlightOnEnter XmCHighlightOnEnter Boolean False CSG XmNhighlightPixmap XmCHighlightPixmap Pixmap dynamic CSG XmNhighlightThickness XmCHighlightThickness Dimension 0 CSG XmNnavigationType XmCNavigationType XmNavigationType XmNONE CSG XmNshadowThickness XmCShadowThickness Dimension 0 CSG XmNtopShadowColor XmCTopShadowColor Pixel dynamic CSG XmNtopShadowPixmap XmCTopShadowPixmap Pixmap dynamic CSG XmNtraversalOn XmCTraversalOn Boolean False CSG XmNunitType XmCUnitType unsigned char dynamic CSG XmNuserData XmCUserData XtPointer NULL CSG CCCCoooorrrreeee RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt NNNNaaaammmmeeee CCCCllllaaaassssssss TTTTyyyyppppeeee DDDDeeeeffffaaaauuuulllltttt AAAAcccccccceeeessssssss ______________________________________________________________________________________________________________ XmNaccelerators XmCAccelerators XtAccelerators dynamic CSG Page 3 (printed 10/3/02) TTTThhhhuuuummmmbbbbWWWWhhhheeeeeeeellll((((3333XXXX)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV TTTThhhhuuuummmmbbbbWWWWhhhheeeeeeeellll((((3333XXXX)))) XmNancestorSensitive XmCSensitive Boolean dynamic G XmNbackground XmCBackground Pixel dynamic CSG XmNbackgroundPixmap XmCPixmap Pixmap XmUNSPECIFIED_PIXMAP CSG XmNborderColor XmCBorderColor Pixel XtDefaultForeground CSG XmNborderPixmap XmCPixmap Pixmap XmUNSPECIFIED_PIXMAP CSG XmNborderWidth XmCBorderWidth Dimension 0 CSG XmNcolormap XmCColormap Colormap dynamic CG XmNdepth XmCDepth int dynamic CG XmNdestroyCallback XmCCallback XtCallbackList NULL C XmNheight XmCHeight Dimension dynamic CSG XmNinitialResourcesPersistent XmCInitialResourcesPersistent Boolean True C XmNmappedWhenManaged XmCMappedWhenManaged Boolean True CSG XmNscreen XmCScreen Screen * dynamic CG XmNsensitive XmCSensitive Boolean True CSG XmNtranslations XmCTranslations XtTranslations dynamic CSG XmNwidth XmCWidth Dimension dynamic CSG XmNx XmCPosition Position 0 CSG XmNy XmCPosition Position 0 CSG CCCCaaaallllllllbbbbaaaacccckkkk IIIInnnnffffoooorrrrmmmmaaaattttiiiioooonnnn A pointer to the following structure is passed to each callback: ttttyyyyppppeeeeddddeeeeffff ssssttttrrrruuuucccctttt {{{{ iiiinnnntttt _r_e_a_s_o_n;;;; XXXXEEEEvvvveeeennnntttt * _e_v_e_n_t;;;; iiiinnnntttt _v_a_l_u_e;;;; }}}} SSSSggggTTTThhhhuuuummmmbbbbWWWWhhhheeeeeeeellllCCCCaaaallllllllbbbbaaaacccckkkkSSSSttttrrrruuuucccctttt;;;; _r_e_a_s_o_n Indicates why the callback was invoked _e_v_e_n_t Points to the XXXXEEEEvvvveeeennnntttt that triggered the callback _v_a_l_u_e Is the new thumb wheel value BBBBeeeehhhhaaaavvvviiiioooorrrr ThumbWheel behavior is described below: BBBBSSSSeeeelllleeeecccctttt PPPPrrrreeeessssssss or BBBBDDDDrrrraaaagggg PPPPrrrreeeessssssss: (in slider): Activates the interactive dragging of the wheel. (in home button): Sets the wheel value to SSSSggggNNNNhhhhoooommmmeeeePPPPoooossssiiiittttiiiioooonnnn. BBBBSSSSeeeelllleeeecccctttt MMMMoooottttiiiioooonnnn or BBBBDDDDrrrraaaagggg MMMMoooottttiiiioooonnnn: If the button press occurs within the wheel, the subsequent motion events spin the wheel to follow Page 4 (printed 10/3/02) TTTThhhhuuuummmmbbbbWWWWhhhheeeeeeeellll((((3333XXXX)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV TTTThhhhuuuummmmbbbbWWWWhhhheeeeeeeellll((((3333XXXX)))) the motion of the pointer and call the callbacks for XXXXmmmmNNNNddddrrrraaaaggggCCCCaaaallllllllbbbbaaaacccckkkk. BBBBSSSSeeeelllleeeecccctttt RRRReeeelllleeeeaaaasssseeee or BBBBDDDDrrrraaaagggg RRRReeeelllleeeeaaaasssseeee: If the button press occurs within the wheel and the wheel position is changed, the callbacks for XXXXmmmmNNNNvvvvaaaalllluuuueeeeCCCChhhhaaaannnnggggeeeeddddCCCCaaaallllllllbbbbaaaacccckkkk are called. VVVViiiirrrrttttuuuuaaaallll BBBBiiiinnnnddddiiiinnnnggggssss The bindings for virtual keys are vendor specific. For information about bindings for virtual buttons and keys, see VVVViiiirrrrttttuuuuaaaallllBBBBiiiinnnnddddiiiinnnnggggssss((((3333XXXX)))). RRRREEEELLLLAAAATTTTEEEEDDDD IIIINNNNFFFFOOOORRRRMMMMAAAATTTTIIIIOOOONNNN SSSSggggTTTThhhhuuuummmmbbbbWWWWhhhheeeeeeeellllGGGGeeeettttVVVVaaaalllluuuueeee((((3333XXXX)))), SSSSggggTTTThhhhuuuummmmbbbbWWWWhhhheeeeeeeellllSSSSeeeettttVVVVaaaalllluuuueeee((((3333XXXX)))), PPPPrrrriiiimmmmiiiittttiiiivvvveeee((((3333XXXX)))), CCCCoooorrrreeee((((3333XXXX)))) Page 5 (printed 10/3/02)